home *** CD-ROM | disk | FTP | other *** search
/ The Amiga Classic Collection / The Amiga Classic Collection - Disc 1.iso / Education / ED16-CrosswordCreator.DMS / ED16-CrosswordCreator.adf / Cross.docE < prev    next >
Text File  |  1991-07-13  |  14KB  |  390 lines
  1. Cross V4.1
  2. ----------
  3.  
  4. Copyright © 1991 by Jürgen Weinelt
  5.                     Zur Kanzel 1
  6.                     D-8783 Hammelburg
  7.                     Germany
  8.  
  9. Cross V4.1 is Freeware. Copy it, but don't make profits with it!
  10.  
  11. Limited licence is granted for non-commercial distribution, epecially for
  12. public domain collectors (Fred Fish).
  13.  
  14. Note: Use this program at your own risk, that is, if it breaks something,
  15.       don't bother me with your problems. I think this is a fair deal;
  16.       please remember you don't have to pay for this program.
  17.       I'd still like to know about major bugs...
  18.  
  19. Note: Cross needs lots of memory. There may be troubles on 512K-Amigas,
  20.       especially if there are several disk drives present.
  21.  
  22. Note: Cross was created on my A2000 with A2630, 1.0MB chip mem,
  23.       2.0MB 32bit fast mem, ECS-Agnus, standard Denise, ALF2 hard disk,
  24.       Kick/WB 1.3, and a HP Deskjet 500 printer.
  25.       If you find any bugs, please send me a detailed report, including a
  26.       description of your system configuration (hardware AND software!)
  27.  
  28.       If you write me a letter, please add a picture postcard or a photo of
  29.       your home town as substitute for the return postage.
  30.  
  31. Note: I apologize for any mistakes I may have made in this text; as you
  32.       probably guessed from my address, English is not my native language...
  33.  
  34.  
  35.  
  36. How to start it
  37. ---------------
  38. CROSS [-xXSIZE] [-yYSIZE] [-d]
  39.          (1)       (2)     (3)
  40.  
  41. Cross accepts up to 3 parameters:
  42.  
  43.  (1) horiz. size; 5<=XSIZE<=39; Default: 25
  44.  
  45.  (2) vert. size;  5<=YSIZE<=35; Default: 25
  46.  
  47.  (3) Debug-mode for the message data file; will be explained later.
  48.  
  49. Parameters may be stated in any order. All parameters are optional.
  50.  
  51. Examples:
  52.   Cross -x9 -y9
  53.   Cross -y21
  54.   Cross -d
  55.   Cross -y13 -d -x39
  56.  
  57.  
  58.  
  59. Before calling Cross, you have to install (with ASSIGN) a logical device
  60. named "CROSS:"; this is where Cross is looking for its data files:
  61.  
  62.  (1) DATA               (directory)
  63.  
  64.  (2) DATA/msgtxt.data   (data file with multilingual program messages)
  65.  
  66.  (3) DATA/words01.crw   (word data file)   or
  67.      DATA/words02.crw   (word data file)
  68.  
  69.  (4) DATA/ (...) .crd   (crossword data files)
  70.  
  71. There are two word data files in this release:
  72.   words01.crw contains German words
  73.   words02.crw contains English words
  74.  
  75.  
  76.  
  77. During startup Cross tries to read the message data file. Then you get
  78. a list of all languages available (just German and English at the
  79. moment), from which you can choose one (enter number, then press return).
  80. A detailed description of the message data file follows later.
  81.  
  82.  
  83.  
  84. Usage
  85. -----
  86. Using Cross should be easy, since most of the options are obvious.
  87. Still you might want to read the detailed menu descriptions:
  88.  
  89. The "Project" menu
  90. ------------------
  91. This is where you find basic activities like load or save:
  92.  
  93. Project : New
  94. -------------
  95. A safety requester asks you to confirm your choice. If you click on
  96. "CONFIRM", the current crossword is dropped and everything is
  97. prepared for the work on a new one.
  98.  
  99. Project : Load crossword
  100. ------------------------
  101. An old crossword data file will be read from disk. File selection is
  102. done with the popular ARP file requester. You should always use the
  103. extension ".crd" for crossword data files.
  104.  
  105. Project : Load word data file
  106. -----------------------------
  107. A different word data file will be loaded. File selection is done
  108. with the ARP file requester. You should always use the extension
  109. ".crw" for word data files.
  110.  
  111. Project : Save crossword
  112. ------------------------
  113. Use this function to save the crossword you are currently working
  114. with. File selection is done with the ARP file requester. You should
  115. always use the extension ".crd" for crossword data files.
  116.  
  117. Project : QUIT
  118. --------------
  119. A safety requester asks you to confirm your choice. If you click on
  120. "CONFIRM", the program will end.
  121.  
  122.  
  123.  
  124. The "Edit" menu
  125. ---------------
  126. Here you'll find anything you need for creating new crosswords.
  127.  
  128. Edit : Auto search mode on/off
  129. ------------------------------
  130. While the auto search mode is active, Cross tries to find words that
  131. fit into the crossword. Two conditions must be fulfilled:
  132.  - a word data file must be present (that is, in memory)
  133.  - at least one word must have been placed as a "seed" from which the
  134.    rest of the crossword can grow
  135. Select this item again to turn auto search mode off.
  136.  
  137. Edit : Enter & place word manually
  138. ----------------------------------
  139. Type the word into the string requester and press return (or click on
  140. "CONFIRM"). Then select a grid position by placing your mouse pointer
  141. and clicking the left mouse button. A second requester asks for
  142. the word direction (horizontal or vertical).
  143.  
  144. Edit : Reset limit
  145. ------------------
  146. Cross uses the limit variable to make sure that long words are placed
  147. before short words. Words must have at least the length stated by limit
  148. or they will not be placed. limit is decremented automatically if no
  149. more words can be placed. Use the "reset limit" function to reset limit
  150. to its original (high) value.
  151.  
  152. Edit : Set crossword size
  153. -------------------------
  154. Two requesters ask for the width and the height of your crossword. Please
  155. note that width and height must be odd.
  156. This function is not available if words have already been placed.
  157.  
  158. Edit : Put seed words
  159. ---------------------
  160. Use this function to place the four seed words from which the rest of
  161. your crossword will grow. You might decide to place some seeds manually
  162. instead of or in addition to using this function; see "Enter and place
  163. word manually".
  164. This function is not available if words have already been placed.
  165.  
  166.  
  167.  
  168. The "Printer" menu
  169. ------------------
  170. The printer menu contains several functions for copying your crosswords
  171. to paper.
  172.  
  173. Printer : Print crossword (generic plain)
  174. -----------------------------------------
  175. This function will hopefully never be used; it does work with almost
  176. any printer except for some really very exotic models, but what you
  177. get is definitely not what one might call "nice" or "good looking"...
  178.  
  179. Printer : Print crossword (generic fancy)
  180. -----------------------------------------
  181. This is the first choice for printing crosswords; it should work with
  182. every graphics printer, if the printer was configured correctly
  183. (-> Preferences).
  184. The "generic fancy" mode needs quite a lot of memory; there may be
  185. problems on 512K Amigas.
  186.  
  187. Printer : Print crossword (LaTeX)
  188. ---------------------------------
  189. If you're a LaTeX user, you can use this function to put your crossword
  190. as a LaTeX source file. File selection is done with the ARP file requester
  191. as usual.
  192. You may have to experiment with the paper width and paper height settings
  193. of your LaTeX environment; try "\oddsidemargin", "\textwidth", "\hoffset"
  194. and "\voffset". Editing the "\unitlength" command enables you to resize
  195. the crossword globally.
  196.  
  197. Printer : Print crossword (Epson)
  198. ---------------------------------
  199. This is a last resort for those who possess a 8/9-needle Epson (-compatible)
  200. matrix printer. Be sure to try "generic fancy" first.
  201.  
  202. Printer : Print crossword solution
  203. ----------------------------------
  204. This function is the same for every printer, since there's no graphics to
  205. be printed here anymay.
  206.  
  207.  
  208.  
  209. message data file
  210. -----------------
  211. This file contains virtually every text used by Cross, at the moment in both
  212. German and English. Other languages can be added easily.
  213. Every entry in the message data file uses exactly one line.
  214.  
  215.  
  216.  
  217. Structure of the message data file
  218. ----------------------------------
  219. The first line of the message data file contains one single digit; this is
  220. the number of languages currently available.
  221.  
  222. This is followed by the name of each language (for example ENGLISH and
  223. DEUTSCH).
  224.  
  225. The following entries are present once for each language, too. These are the
  226. program messages.
  227.  
  228. If you want to add another language to the message data file, please make
  229. sure that your translation has approx. the same size as the original
  230. message, because some of them appear in requesters or menus.
  231.  
  232. Every entry must start with a three-digit number. This number must be
  233. identical with the actual number (count 'em) of this message (sounds
  234. difficult; just take a close look at the message data file, you'll see what
  235. it means...).
  236.  
  237. The only exception to this rule is entry number "999" which signals
  238. the "End of file".
  239.  
  240. If you encounter any problems after adding another language, just
  241. call "Cross" with the message debug mode on (parameter "-d"). This causes
  242. the message numbers to be displayed with the messages themselves; it will
  243. (hopefully) help you locate the problem.
  244.  
  245.  
  246.  
  247. ¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡
  248. ############################################################################
  249. Did you add another language to the message data file? Please send me a
  250. copy of your message data file on disk, it'll be included with the next
  251. release of Cross. As a reward I'll send your disk back with another one of
  252. my PD programs.
  253. ############################################################################
  254. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  255.  
  256.  
  257.  
  258. Word data files
  259. ---------------
  260. If you want to create your own word data files, please note:
  261.  
  262.  (1) You may use every character you want to, even national characters
  263.      like "ä § ø ¥", spaces or ": ; , #"...
  264.      These special characters will not be displayed on screen, but they
  265.      will be printed, if your printer is configured correctly through
  266.      "Preferences".
  267.  
  268.  (2) The word length should always be odd, that is, 3, 5, 7, ... 25; (except
  269.      for two letter words). Maximum length is 25, minimum is 2.
  270.      These limitations are needed to improve the structure of the crossword.
  271.      You MAY use words with even length, but this will probably cause larger
  272.      gaps in the crossword.
  273.  
  274.  (4) The word data file must not contain empty lines.
  275.  
  276.  (5) The last entry may or may not be "***END***", without quotation marks,
  277.      of course; that means "***END***" is not needed, but will be ignored
  278.      if present.
  279.  
  280.  
  281.  
  282. Yes, you're right. There is an easier way of creating word data files...
  283. Just run any standard ASCII text file through the "PreProcessor", which
  284. should also be somewhere in the "Cross" drawer. PreProcessor will break it
  285. down into single words and will remove anything illegal (PreProcessor still
  286. uses the strict Version 3 rules for words). You'll have to use
  287. your favourite editor though to delete all those words you don't want to use.
  288. There may also be some "crippled" words that didn't survive the PreProcessor.
  289.  
  290. Usage of the PreProcessor:
  291.   PreProcessor
  292.  
  293. There are no command line parameters; file selection is done by ARP file
  294. requesters.
  295.  
  296. Note: The PreProcessor uses a recursive algorithm (builds a binary tree
  297.       to sort the words); please make sure there's enough stack space
  298.       available. You can increase the stack space with a CLI command
  299.       called "STACK". PreProcessor automatically allocates 50000 bytes
  300.       of stack space; if you need more than that, use the STACK command.
  301.       PreProcessor is very greedy anyway... i'm sure there's going to be
  302.       trouble with it on 512K Amigas if you try to convert large ASCII
  303.       text files.
  304.  
  305.  
  306.  
  307. Just a warning: if your word data file is very large (that is, if it
  308. contains MANY, MANY, MANY words), the creation of the crossword will
  309. be slowed down considerably. In order to avoid this effect, you might use
  310. several small word data files, loading the next when the current file is
  311. used up.
  312.  
  313. An example:
  314.  
  315.   File        | word length
  316.   ------------+------------
  317.   words05.crw | 25..17
  318.   words06.crw | 15.. 9
  319.   words07.crw |  7.. 5
  320.   words08.crw |  3.. 2
  321.  
  322.  
  323.  
  324. Known problems/bugs of Cross
  325. ----------------------------
  326.  - (very seldom) TRAP 11 during program startup, reason: unknown
  327.  - (very seldom) memory fragmentation, reason: unknown
  328.  
  329. If you encounter any bugs, please send me a detailed report.
  330.  
  331.  
  332.  
  333. Things to be done
  334. -----------------
  335.  - removing words from the crossword
  336.  
  337.  - several patterns for setting the "seed" word(s)
  338.  
  339.  - user configurations
  340.  
  341.  - crosswords with custom layouts instead of rectangles.
  342.  
  343.  
  344.  
  345. History
  346. =======
  347.  
  348. V4.1    RELEASEd on AMOK and FISH
  349.         Cross can be made RESIDENT now.
  350.         several bugs fixed (?)
  351.  
  352. V4.0    using menus instead of gadgets
  353.         new printer drivers including hires, generic and LaTeX
  354.         "New crossword"
  355.         "New size"
  356.         needs much less memory (semi-dynamic word storage)
  357.         improved PAL/NTSC-support
  358.         faster
  359.  
  360. V3.5A   intermediate version with some dirty bug fixes [removed in V4.0]
  361.  
  362. V3.5    still struggling with the new compiler
  363.  
  364. V3.4    changed to compiler version 4.096d
  365.  
  366. V3.3    RELEASE on FISH
  367.         automatic PAL/NTSC recognition by examining "height" field of
  368.         workbench screen
  369.         fixed some minor errors in program and documentation
  370.  
  371. V3.2    first RELEASE of M2 version on AMOK
  372.  
  373.  
  374.  
  375. Enjoy!
  376.  
  377.  
  378.  
  379.                    ####################################
  380.                  ########################################
  381.                 ##                                      ##
  382.                ##    /¯¯¯¯\   \\|||// \              /   ##
  383.                ##   /      \  \|o o|/  \            /    ##
  384.                ##          |   | . |    \    /\    /     ##
  385.                ##   \      /   | ' |     \  /  \  /      ##
  386.                ##    \____/    \ ~ /      \/    \/       ##
  387.                 ##              ¯¯¯                     ##
  388.                  ########################################
  389.                    ####################################
  390.